<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "https://www.w3.org/TR/html4/loose.dtd">
<html lang="zh-CN"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta http-equiv="Content-Language" content="zh-CN"><link href="stylesheet.css" media="all" rel="stylesheet" type="text/css">
<title>CREATE TYPE</title>
<script> var _hmt = _hmt || []; (function() { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?d286c55b63a3c54a1e43d10d4c203e75"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s); })(); </script>
</head><body class="REFENTRY">
<div>
<table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr><th colspan="5" align="center" valign="bottom">PostgreSQL 8.2.3 中文文档</th></tr>
<tr><td width="10%" align="left" valign="top"><a href="sql-createtrigger.html" accesskey="P">后退</a></td><td width="10%" align="left" valign="top"><a href="sql-createtrigger.html">快退</a></td><td width="60%" align="center" valign="bottom"></td><td width="10%" align="right" valign="top"><a href="sql-createuser.html">快进</a></td><td width="10%" align="right" valign="top"><a href="sql-createuser.html" accesskey="N">前进</a></td></tr>
</table>
<hr align="LEFT" width="100%"></div>
<h1><a name="SQL-CREATETYPE"></a>CREATE TYPE</h1>
<div class="REFNAMEDIV"><a name="AEN49626"></a><h2>名称</h2>CREATE TYPE&nbsp;--&nbsp;定义一个新数据类型</div>
<a name="AEN49629"></a>
<div class="REFSYNOPSISDIV"><a name="AEN49631"></a><h2>语法</h2>
<pre class="SYNOPSIS">CREATE TYPE <tt class="REPLACEABLE"><i>name</i></tt> AS
    ( <tt class="REPLACEABLE"><i>attribute_name</i></tt> <tt class="REPLACEABLE"><i>data_type</i></tt> [, ... ] )

CREATE TYPE <tt class="REPLACEABLE"><i>name</i></tt> (
    INPUT = <tt class="REPLACEABLE"><i>input_function</i></tt>,
    OUTPUT = <tt class="REPLACEABLE"><i>output_function</i></tt>
    [ , RECEIVE = <tt class="REPLACEABLE"><i>receive_function</i></tt> ]
    [ , SEND = <tt class="REPLACEABLE"><i>send_function</i></tt> ]
    [ , ANALYZE = <tt class="REPLACEABLE"><i>analyze_function</i></tt> ]
    [ , INTERNALLENGTH = { <tt class="REPLACEABLE"><i>internallength</i></tt> | VARIABLE } ]
    [ , PASSEDBYVALUE ]
    [ , ALIGNMENT = <tt class="REPLACEABLE"><i>alignment</i></tt> ]
    [ , STORAGE = <tt class="REPLACEABLE"><i>storage</i></tt> ]
    [ , DEFAULT = <tt class="REPLACEABLE"><i>default</i></tt> ]
    [ , ELEMENT = <tt class="REPLACEABLE"><i>element</i></tt> ]
    [ , DELIMITER = <tt class="REPLACEABLE"><i>delimiter</i></tt> ]
)

CREATE TYPE <tt class="REPLACEABLE"><i>name</i></tt></pre>
</div>
<div class="REFSECT1"><a name="AEN49649"></a><h2>描述</h2>
<p><tt class="COMMAND">CREATE TYPE</tt> 为当前数据库注册一个新的数据类型。定义该类型的用户成为其所有者。</p>
<p>如果给出模式名，那么该类型是在指定模式中创建。否则它将在当前模式中创建。类型名必需和同一模式中任何现有的类型或者域不同。因为表和数据类型有联系，所以类型名也不能和同模式中的表名字冲突。</p>
<div class="REFSECT2"><a name="AEN49654"></a><h3>复合类型</h3>
<p>第一种形式的 <tt class="COMMAND">CREATE TYPE</tt> 创建一个复合类型。复合类型是通过一列属性名和数据类型声明的。这样实际上和一个表的行类型一样，但是如果只是想定义一个类型，那么使用 <tt class="COMMAND">CREATE TYPE</tt> 就可以避免直接创建实际的表。一个独立的复合类型做一个函数的参数或者返回类型是非常有用的。</p>
</div>
<div class="REFSECT2"><a name="AEN49659"></a><h3>基本类型</h3>
<p>第二种形式的<tt class="COMMAND">CREATE TYPE</tt> 创建一种新的基本类型(标量类型)。参数可以按任意顺序出现，而不是上面显示的那样，并且大多数都是可选的。它要求要在定义类型之前先用 <tt class="COMMAND">CREATE FUNCTION</tt> 注册两个或更多个函数。支持函数 <tt class="REPLACEABLE"><i>input_function</i></tt> 和 <tt class="REPLACEABLE"><i>output_function</i></tt> 是必须的，而函数 <tt class="REPLACEABLE"><i>receive_function</i></tt>, <tt class="REPLACEABLE"><i>send_function</i></tt>, <tt class="REPLACEABLE"><i>analyze_function</i></tt> 是可选的。通常，这些函数必须用 C 或者其它低层语言编写。</p>
<p><tt class="REPLACEABLE"><i>input_function</i></tt> 函数将该类型的外部文本形式转换成可以被该类型的操作符和函数识别的内部形式。<tt class="REPLACEABLE"><i>output_function</i></tt> 用途相反。输入函数可以声明为接受一个类型为 <tt class="TYPE">cstring</tt> 的参数，或者接受三个类型分别为 <tt class="TYPE">cstring</tt>, <tt class="TYPE">oid</tt>, <tt class="TYPE">integer</tt> 的参数。第一个参数是 C 字符串形式的输入文本，第二个参数是该类型自身的 OID(数组类型除外，这种情况下它们接受自身元素的类型 OID)，第三个是目标字段的 <tt class="LITERAL">typmod</tt>(如果未知则传递 -1)。输入函数必须返回一个自身数据类型的值。通常，输入函数应当被声明为 STRICT ，否则当读取 NULL 输入时将被使用第一个参数为 NULL 进行调用，并且必须仍然返回 NULL 或报错。这个特性主要是为了支持域输入函数，这种函数可能需要拒绝 NULL 输入。输出函数必须被声明为接受一个新数据类型的参数，并且必须返回 <tt class="TYPE">cstring</tt> 类型。输出函数不会被使用 NULL 调用。</p>
<p>可选的 <tt class="REPLACEABLE"><i>receive_function</i></tt> 把该类型的外部二进制表现形式转换成内部表现形式。如果没有提供这个函数，那么该类型不能用二进制输入。二进制格式应该选取那种比较容易转换同时还有一定移植性的内部格式。比如，标准的整数数据类型使用网络字节序作为外部的二进制表现形式，而内部表现形式则是机器的本机字节序。例如，接收函数应该声明为接受一个类型为 <tt class="TYPE">internal</tt> 的参数，或者是三个类型分别为 <tt class="TYPE">internal</tt>, <tt class="TYPE">oid</tt>, <tt class="TYPE">integer</tt> 的参数。第一个参数是一个指向一个 <tt class="TYPE">StringInfo</tt> 缓冲区的、保存接受字节串的指针；可选的参数和文本输入函数一样。接收函数必须返回一个该类型的数据值。通常接收函数应当被声明为 STRICT ，否则否则当读取 NULL 输入时将被使用第一个参数为 NULL 进行调用，并且必须仍然返回 NULL 或报错。这个特性主要是为了支持域接收函数，这种函数可能需要拒绝 NULL 输入。同样，可选的 <tt class="REPLACEABLE"><i>send_function</i></tt> 把类型的内部表现形式转换为外部二进制表现形式。如果没有提供这些函数，那么类型就不能用二进制方式输出。发送函数必须声明为接收一个新数据类型并且必须返回 <tt class="TYPE">bytea</tt> 结果。发送函数不会被以 NULL 值调用。</p>
<p>这个时候你应该觉得奇怪，输入和输出函数怎么可以声明为返回新类型的结果或者是接受新类型的参数，而且是在新类型创建之前就需要创建它们。答案是类型必须被首先定义为一个<i class="FIRSTTERM">壳类型</i>，它只是一个除了名称和属主之外没有其他属性的占位符类型。这可以通过没有其他额外参数的 <tt class="LITERAL">CREATE TYPE <tt class="REPLACEABLE"><i>name</i></tt></tt> 命令来完成。然后就可以引用该壳类型定义输入输出函数。最后，<tt class="COMMAND">CREATE TYPE</tt> 把这个壳类型替换成完整的、有效的类型定义，这样就可以使用新类型了。</p>
<p>可选的 <tt class="REPLACEABLE"><i>analyze_function</i></tt> 为该数据类型的字段执行与该类型相关的统计信息收集。缺省的时，如果该类型有个缺省的 B-tree 操作符类，那么 <tt class="COMMAND">ANALYZE</tt> 将尝试使用该类型的"等于"和"小于"操作符收集信息。对于非标量类型，这种行为很可能不合适，因此可以通过提供一个自定义的分析函数覆盖它。分析函数必须声明为接收单独一个 <tt class="TYPE">internal</tt> 类型的参数，并且返回一个 <tt class="TYPE">boolean</tt> 结果。分析函数的详细 API 在 <tt class="FILENAME">src/include/commands/vacuum.h</tt> 里。</p>
<p>尽管新类型的内部表现形式只有输入输出函数和其它你创建来使用该类型的函数了解，但内部表现形式还是有几个属性必须为 PostgreSQL 声明。<tt class="REPLACEABLE"><i>internallength</i></tt> 是最重要的一个。基本数据类型可定义成为定长，这时 <tt class="REPLACEABLE"><i>internallength</i></tt> 是一个正整数，也可以是变长的，这时用把 <tt class="REPLACEABLE"><i>internallength</i></tt> 设为 <tt class="LITERAL">VARIABLE</tt> 表示(在内部，这个状态是通过将 <tt class="LITERAL">typlen</tt> 设置为-1 实现的)。所有变长类型的内部形式都必须以一个四字节整数开头，这个整数给出此类型这个数值的全长。</p>
<p>可选的标记 <tt class="LITERAL">PASSEDBYVALUE</tt> 表明该类型的数值是按值而不是引用传递。你不能传递那些内部形式大于 <tt class="TYPE">Datum</tt> 类型尺寸(大多数机器上是 4 字节，有些是 8 字节)的数据类型的值。</p>
<p><tt class="REPLACEABLE"><i>alignment</i></tt> 参数声明该数据类型要求的对齐存储方式。允许的数值等效于按照 1, 2, 4, 8 字节边界对齐。请注意变长类型必须有至少 4 字节的对齐，因为它们必须包含一个 <tt class="TYPE">int4</tt> 作为第一个部分。</p>
<p><tt class="REPLACEABLE"><i>storage</i></tt> 参数允许为变长数据类型选择存储策略(定长类型只允许使用 <tt class="LITERAL">plain</tt>)。<tt class="LITERAL">plain</tt> 声明该数据类型总是用内联的方式而不是压缩的方式存储。<tt class="LITERAL">extended</tt> 声明系统将首先试图压缩一个长的数据值，然后如果它仍然太长的话就将它的值移出主表，但系统将不会压缩它。<tt class="LITERAL">external</tt> 声明禁止系统进行压缩并且允许将它的值移出主表。<tt class="LITERAL">main</tt> 允许压缩，但是不赞成把数值移动出主表(如果实在不能放在一行里的话，仍将移动出主表)，它比 <tt class="LITERAL">extended</tt> 和 <tt class="LITERAL">external</tt> 项更愿意保存在主表里。</p>
<p>如果用户希望字段的数据类型缺省时不是 NULL ，那么可以在 <tt class="LITERAL">DEFAULT</tt> 关键字里声明一个缺省值(可以被附着在特定字段上的 <tt class="LITERAL">DEFAULT</tt> 子句覆盖)。</p>
<p>用 <tt class="LITERAL">ELEMENT</tt> 关键字声明数组元素的类型。比如，<tt class="LITERAL">ELEMENT = int4</tt> 定义了一个 4 字节整数(<tt class="TYPE">int4</tt>)的数组。有关数组类型的更多细节在下面描述。</p>
<p>可用 <tt class="REPLACEABLE"><i>delimiter</i></tt> 指定用于这种类型数组的外部形式的数值之间的分隔符。缺省的分隔符是逗号(<tt class="LITERAL">,</tt>)。请注意分隔符是和数组元素类型相关联，而不是数组类型本身。</p>
</div>
<div class="REFSECT2"><a name="AEN49732"></a><h3>数组类型</h3>
<p>在创建用户定义数据类型的时候，PostgreSQL 自动创建一个与之关联的数组类型，其名字由该基本类型的名字前缀一个下划线组成。分析器理解这个命名传统，并且把对类型为 <tt class="LITERAL">foo[]</tt> 的字段的请求转换成对类型为 <tt class="LITERAL">_foo</tt> 的字段的请求。这个隐含创建的数组类型是变长并且使用内建的 <tt class="LITERAL">array_in</tt> 和 <tt class="LITERAL">array_out</tt> 输入和输出函数。</p>
<p>你很可能会问如果系统自动制作正确的数组类型，那为什么还要有个 <tt class="OPTION">ELEMENT</tt> 选项?使用 <tt class="OPTION">ELEMENT</tt> 的场合有二：你定义的定长类型碰巧在内部是一个一定数目相同事物的数组，而你又想允许这 N 个事物可以通过下标直接关联；某些操作符将把该类型当做整体进行处理。 比如，构成 <tt class="TYPE">name</tt> 类型的 <tt class="TYPE">char</tt> 成员就允许用这种方法关联。一个二维的 <tt class="TYPE">point</tt> 类型也可以允许其两个浮点型构成成员按照类似 <tt class="LITERAL">point[0]</tt> 和 <tt class="LITERAL">point[1]</tt> 的方法关联。请注意这个功能只适用于定长类型，并且其内部形式是一个相同定长域的序列。一个可以下标化的变长类型必须有被 <tt class="LITERAL">array_in</tt> 和 <tt class="LITERAL">array_out</tt> 使用的一般化的内部表现形式。出于历史原因，定长数组类型的下标从 0 开始，而不是像变长类型那样的从 1 开始。</p>
</div>
</div>
<div class="REFSECT1"><a name="AEN49750"></a><h2>参数</h2>
<div class="VARIABLELIST">
<dl>
<dt><tt class="REPLACEABLE"><i>name</i></tt></dt>
<dd><p>将要创建的类型名(可以有模式修饰)</p></dd>
<dt><tt class="REPLACEABLE"><i>attribute_name</i></tt></dt>
<dd><p>复合类型的一个属性(字段)的名字</p></dd>
<dt><tt class="REPLACEABLE"><i>data_type</i></tt></dt>
<dd><p>要成为一个复合类型的字段的现有数据类型的名字</p></dd>
<dt><tt class="REPLACEABLE"><i>input_function</i></tt></dt>
<dd><p>一个函数的名称，将数据从外部文本形式转换成内部格式。</p></dd>
<dt><tt class="REPLACEABLE"><i>output_function</i></tt></dt>
<dd><p>一个函数的名称，将数据从内部格式转换成适于显示的外部文本形式。</p></dd>
<dt><tt class="REPLACEABLE"><i>receive_function</i></tt></dt>
<dd><p>把数据从类型的外部二进制形式转换成内部形式的函数名称</p></dd>
<dt><tt class="REPLACEABLE"><i>send_function</i></tt></dt>
<dd><p>把数据从类型的内部形式转换成外部二进制形式的函数名称</p></dd>
<dt><tt class="REPLACEABLE"><i>analyze_function</i></tt></dt>
<dd><p>为该数据类型执行统计分析的函数名</p></dd>
<dt><tt class="REPLACEABLE"><i>internallength</i></tt></dt>
<dd><p>一个数值常量，说明新类型的内部表现形式的长度。缺省假定它是变长的。</p></dd>
<dt><tt class="REPLACEABLE"><i>alignment</i></tt></dt>
<dd><p>该数据类型的存储对齐要求。如果声明了，必须是 <tt class="LITERAL">char</tt>, <tt class="LITERAL">int2</tt>, <tt class="LITERAL">int4</tt>(缺省), <tt class="LITERAL">double</tt> 之一。</p></dd>
<dt><tt class="REPLACEABLE"><i>storage</i></tt></dt>
<dd><p>该数据类型的存储策略。如果声明了，必须是 <tt class="LITERAL">plain</tt>(缺省), <tt class="LITERAL">external</tt>, <tt class="LITERAL">extended</tt>, <tt class="LITERAL">main</tt> 之一。</p></dd>
<dt><tt class="REPLACEABLE"><i>default</i></tt></dt>
<dd><p>该类型的缺省值。若省略则为 NULL</p></dd>
<dt><tt class="REPLACEABLE"><i>element</i></tt></dt>
<dd><p>被创建的类型是数组；这个声明数组元素的类型。</p></dd>
<dt><tt class="REPLACEABLE"><i>delimiter</i></tt></dt>
<dd><p>数组元素之间分隔符</p></dd>
</dl>
</div>
</div>
<div class="REFSECT1"><a name="SQL-CREATETYPE-NOTES"></a><h2>注意</h2>
<p>用户定义类型名不能以下划线(<tt class="LITERAL">_</tt>)开头而且只能有 62 个字符长，或者说是 <tt class="SYMBOL">NAMEDATALEN</tt>-2 个(而不是其它名字那样的可以有 <tt class="SYMBOL">NAMEDATALEN</tt>-1 个字符)。以下划线开头的类型名被解析成内部创建的数组类型名。</p>
<p>因为一旦类型被创建之后对它的使用就没有限制，所以创建一个基本类型就等价于授予所有用户执行类型定义中指定的各个函数的权限，同时该类型的创建者也将是这些函数的拥有者。这对于大多数类型定义中指定的函数来说不会造成什么不良问题。但是如果你设计的新类型在内部形式和外部形式之间转换的时候使用"敏感信息"，那么你仍然要再三考虑、多加小心。</p>
<p>在 PostgreSQL 8.2 之前的版本中，并不存在 <tt class="LITERAL">CREATE TYPE <tt class="REPLACEABLE"><i>name</i></tt></tt> 语法。创建新的基本类型之前必须首先创建其输入函数。这样，PostgreSQL 将会首先把新类型的名字看作输入函数的返回类型并隐含创建壳类型，然后这个壳类型将被随后定义的输入输出函数引用。这种老式的方法目前仍然被支持，但已经反对使用，将来可能不再支持。同样，为了避免函数定义中的临时壳类型偶然地搞乱系统表，当输入函数用 C 语言书写时，将只能用这种方法创建壳类型。</p>
<p>在 PostgreSQL 7.3 以前，要通过使用占位伪类型 <tt class="TYPE">opaque</tt> 代替函数的前向引用来避免创建壳类型。7.3 之前 <tt class="TYPE">cstring</tt> 参数和结果同样需要声明伪 <tt class="TYPE">opaque</tt> 。要支持加载旧的转储文件，<tt class="COMMAND">CREATE TYPE</tt> 将接受那些用 <tt class="TYPE">opaque</tt> 声明的输入输出函数，但是它将发出一条通知并且用正确的类型改变函数的声明。</p>
</div>
<div class="REFSECT1"><a name="AEN49853"></a><h2>例子</h2>
<p>这个例子创建一个复合类型并且在一个函数定义中使用它：</p>
<pre class="PROGRAMLISTING">CREATE TYPE compfoo AS (f1 int, f2 text);

CREATE FUNCTION getfoo() RETURNS SETOF compfoo AS $$
    SELECT fooid, fooname FROM foo
$$ LANGUAGE SQL;</pre>
<p>这个命令创建 <tt class="TYPE">box</tt> 数据类型，并且将这种类型用于一个表定义：</p>
<pre class="PROGRAMLISTING">CREATE TYPE box;

CREATE FUNCTION my_box_in_function(cstring) RETURNS box AS ... ;
CREATE FUNCTION my_box_out_function(box) RETURNS cstring AS ... ;

CREATE TYPE box (
    INTERNALLENGTH = 16,
    INPUT = my_box_in_function,
    OUTPUT = my_box_out_function
);

CREATE TABLE myboxes (
    id integer,
    description box
);</pre>
<p>如果 <tt class="TYPE">box</tt> 的内部结构是一个四个 <tt class="TYPE">float4</tt> 的数组，可以使用</p>
<pre class="PROGRAMLISTING">CREATE TYPE box (
    INTERNALLENGTH = 16,
    INPUT = my_box_in_function,
    OUTPUT = my_box_out_function,
    ELEMENT = float4
);</pre>
<p>来允许一个 box 的数值成分成员可以用下标访问。否则该类型和前面的行为一样。</p>
<p>这条命令创建一个大对象类型并将其用于一个表定义：</p>
<pre class="PROGRAMLISTING">CREATE TYPE bigobj (
    INPUT = lo_filein, OUTPUT = lo_fileout,
    INTERNALLENGTH = VARIABLE
);
CREATE TABLE big_objs (
    id integer,
    obj bigobj
);</pre>
<p>更多的例子，包括合适的输入和输出函数，位于<a href="xtypes.html">节33.11</a>。</p>
</div>
<div class="REFSECT1"><a name="SQL-CREATETYPE-COMPATIBILITY"></a><h2>兼容性</h2>
<p><tt class="COMMAND">CREATE TYPE</tt> 命令是 PostgreSQL 扩展。在 SQL 里有一个 <tt class="COMMAND">CREATE TYPE</tt> 语句，但是细节和 PostgreSQL 有比较大区别。</p>
</div>
<div class="REFSECT1"><a name="SQL-CREATETYPE-SEE-ALSO"></a><h2>又见</h2><a href="sql-createfunction.html"><i>CREATE FUNCTION</i></a>, <a href="sql-droptype.html"><i>DROP TYPE</i></a>, <a href="sql-altertype.html"><i>ALTER TYPE</i></a>, <a href="sql-createdomain.html"><i>CREATE DOMAIN</i></a></div>
<div>
<hr align="LEFT" width="100%">
<table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr><td width="33%" align="left" valign="top"><a href="sql-createtrigger.html" accesskey="P">后退</a></td><td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">首页</a></td><td width="33%" align="right" valign="top"><a href="sql-createuser.html" accesskey="N">前进</a></td></tr>
<tr><td width="33%" align="left" valign="top">CREATE TRIGGER</td><td width="34%" align="center" valign="top"><a href="sql-commands.html" accesskey="U">上一级</a></td><td width="33%" align="right" valign="top">CREATE USER</td></tr>
</table>
</div>
</body></html>